home *** CD-ROM | disk | FTP | other *** search
/ Freelog 115 / FreelogNo115-MaiJuin2013.iso / Internet / Filezilla Server / FileZilla_Server-0_9_41.exe / source / includes / openssl / store.h < prev    next >
C/C++ Source or Header  |  2012-02-26  |  26KB  |  555 lines
  1. /* crypto/store/store.h -*- mode:C; c-file-style: "eay" -*- */
  2. /* Written by Richard Levitte (richard@levitte.org) for the OpenSSL
  3.  * project 2003.
  4.  */
  5. /* ====================================================================
  6.  * Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
  7.  *
  8.  * Redistribution and use in source and binary forms, with or without
  9.  * modification, are permitted provided that the following conditions
  10.  * are met:
  11.  *
  12.  * 1. Redistributions of source code must retain the above copyright
  13.  *    notice, this list of conditions and the following disclaimer. 
  14.  *
  15.  * 2. Redistributions in binary form must reproduce the above copyright
  16.  *    notice, this list of conditions and the following disclaimer in
  17.  *    the documentation and/or other materials provided with the
  18.  *    distribution.
  19.  *
  20.  * 3. All advertising materials mentioning features or use of this
  21.  *    software must display the following acknowledgment:
  22.  *    "This product includes software developed by the OpenSSL Project
  23.  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24.  *
  25.  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26.  *    endorse or promote products derived from this software without
  27.  *    prior written permission. For written permission, please contact
  28.  *    openssl-core@openssl.org.
  29.  *
  30.  * 5. Products derived from this software may not be called "OpenSSL"
  31.  *    nor may "OpenSSL" appear in their names without prior written
  32.  *    permission of the OpenSSL Project.
  33.  *
  34.  * 6. Redistributions of any form whatsoever must retain the following
  35.  *    acknowledgment:
  36.  *    "This product includes software developed by the OpenSSL Project
  37.  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38.  *
  39.  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40.  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42.  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50.  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51.  * ====================================================================
  52.  *
  53.  * This product includes cryptographic software written by Eric Young
  54.  * (eay@cryptsoft.com).  This product includes software written by Tim
  55.  * Hudson (tjh@cryptsoft.com).
  56.  *
  57.  */
  58.  
  59. #ifndef HEADER_STORE_H
  60. #define HEADER_STORE_H
  61.  
  62. #include <openssl/ossl_typ.h>
  63. #ifndef OPENSSL_NO_DEPRECATED
  64. #include <openssl/evp.h>
  65. #include <openssl/bn.h>
  66. #include <openssl/x509.h>
  67. #endif
  68.  
  69. #ifdef  __cplusplus
  70. extern "C" {
  71. #endif
  72.  
  73. /* Already defined in ossl_typ.h */
  74. /* typedef struct store_st STORE; */
  75. /* typedef struct store_method_st STORE_METHOD; */
  76.  
  77.  
  78. /* All the following functions return 0, a negative number or NULL on error.
  79.    When everything is fine, they return a positive value or a non-NULL
  80.    pointer, all depending on their purpose. */
  81.  
  82. /* Creators and destructor.   */
  83. STORE *STORE_new_method(const STORE_METHOD *method);
  84. STORE *STORE_new_engine(ENGINE *engine);
  85. void STORE_free(STORE *ui);
  86.  
  87.  
  88. /* Give a user interface parametrised control commands.  This can be used to
  89.    send down an integer, a data pointer or a function pointer, as well as
  90.    be used to get information from a STORE. */
  91. int STORE_ctrl(STORE *store, int cmd, long i, void *p, void (*f)(void));
  92.  
  93. /* A control to set the directory with keys and certificates.  Used by the
  94.    built-in directory level method. */
  95. #define STORE_CTRL_SET_DIRECTORY    0x0001
  96. /* A control to set a file to load.  Used by the built-in file level method. */
  97. #define STORE_CTRL_SET_FILE        0x0002
  98. /* A control to set a configuration file to load.  Can be used by any method
  99.    that wishes to load a configuration file. */
  100. #define STORE_CTRL_SET_CONF_FILE    0x0003
  101. /* A control to set a the section of the loaded configuration file.  Can be
  102.    used by any method that wishes to load a configuration file. */
  103. #define STORE_CTRL_SET_CONF_SECTION    0x0004
  104.  
  105.  
  106. /* Some methods may use extra data */
  107. #define STORE_set_app_data(s,arg)    STORE_set_ex_data(s,0,arg)
  108. #define STORE_get_app_data(s)        STORE_get_ex_data(s,0)
  109. int STORE_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
  110.     CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
  111. int STORE_set_ex_data(STORE *r,int idx,void *arg);
  112. void *STORE_get_ex_data(STORE *r, int idx);
  113.  
  114. /* Use specific methods instead of the built-in one */
  115. const STORE_METHOD *STORE_get_method(STORE *store);
  116. const STORE_METHOD *STORE_set_method(STORE *store, const STORE_METHOD *meth);
  117.  
  118. /* The standard OpenSSL methods. */
  119. /* This is the in-memory method.  It does everything except revoking and updating,
  120.    and is of course volatile.  It's used by other methods that have an in-memory
  121.    cache. */
  122. const STORE_METHOD *STORE_Memory(void);
  123. #if 0 /* Not yet implemented */
  124. /* This is the directory store.  It does everything except revoking and updating,
  125.    and uses STORE_Memory() to cache things in memory. */
  126. const STORE_METHOD *STORE_Directory(void);
  127. /* This is the file store.  It does everything except revoking and updating,
  128.    and uses STORE_Memory() to cache things in memory.  Certificates are added
  129.    to it with the store operation, and it will only get cached certificates. */
  130. const STORE_METHOD *STORE_File(void);
  131. #endif
  132.  
  133. /* Store functions take a type code for the type of data they should store
  134.    or fetch */
  135. typedef enum STORE_object_types
  136.     {
  137.     STORE_OBJECT_TYPE_X509_CERTIFICATE=    0x01, /* X509 * */
  138.     STORE_OBJECT_TYPE_X509_CRL=        0x02, /* X509_CRL * */
  139.     STORE_OBJECT_TYPE_PRIVATE_KEY=        0x03, /* EVP_PKEY * */
  140.     STORE_OBJECT_TYPE_PUBLIC_KEY=        0x04, /* EVP_PKEY * */
  141.     STORE_OBJECT_TYPE_NUMBER=        0x05, /* BIGNUM * */
  142.     STORE_OBJECT_TYPE_ARBITRARY=        0x06, /* BUF_MEM * */
  143.     STORE_OBJECT_TYPE_NUM=            0x06  /* The amount of known
  144.                              object types */
  145.     } STORE_OBJECT_TYPES;
  146. /* List of text strings corresponding to the object types. */
  147. extern const char * const STORE_object_type_string[STORE_OBJECT_TYPE_NUM+1];
  148.  
  149. /* Some store functions take a parameter list.  Those parameters come with
  150.    one of the following codes. The comments following the codes below indicate
  151.    what type the value should be a pointer to. */
  152. typedef enum STORE_params
  153.     {
  154.     STORE_PARAM_EVP_TYPE=            0x01, /* int */
  155.     STORE_PARAM_BITS=            0x02, /* size_t */
  156.     STORE_PARAM_KEY_PARAMETERS=        0x03, /* ??? */
  157.     STORE_PARAM_KEY_NO_PARAMETERS=        0x04, /* N/A */
  158.     STORE_PARAM_AUTH_PASSPHRASE=        0x05, /* char * */
  159.     STORE_PARAM_AUTH_KRB5_TICKET=        0x06, /* void * */
  160.     STORE_PARAM_TYPE_NUM=            0x06  /* The amount of known
  161.                              parameter types */
  162.     } STORE_PARAM_TYPES;
  163. /* Parameter value sizes.  -1 means unknown, anything else is the required size. */
  164. extern const int STORE_param_sizes[STORE_PARAM_TYPE_NUM+1];
  165.  
  166. /* Store functions take attribute lists.  Those attributes come with codes.
  167.    The comments following the codes below indicate what type the value should
  168.    be a pointer to. */
  169. typedef enum STORE_attribs
  170.     {
  171.     STORE_ATTR_END=                0x00,
  172.     STORE_ATTR_FRIENDLYNAME=        0x01, /* C string */
  173.     STORE_ATTR_KEYID=            0x02, /* 160 bit string (SHA1) */
  174.     STORE_ATTR_ISSUERKEYID=            0x03, /* 160 bit string (SHA1) */
  175.     STORE_ATTR_SUBJECTKEYID=        0x04, /* 160 bit string (SHA1) */
  176.     STORE_ATTR_ISSUERSERIALHASH=        0x05, /* 160 bit string (SHA1) */
  177.     STORE_ATTR_ISSUER=            0x06, /* X509_NAME * */
  178.     STORE_ATTR_SERIAL=            0x07, /* BIGNUM * */
  179.     STORE_ATTR_SUBJECT=            0x08, /* X509_NAME * */
  180.     STORE_ATTR_CERTHASH=            0x09, /* 160 bit string (SHA1) */
  181.     STORE_ATTR_EMAIL=            0x0a, /* C string */
  182.     STORE_ATTR_FILENAME=            0x0b, /* C string */
  183.     STORE_ATTR_TYPE_NUM=            0x0b, /* The amount of known
  184.                              attribute types */
  185.     STORE_ATTR_OR=                0xff  /* This is a special
  186.                              separator, which
  187.                              expresses the OR
  188.                              operation.  */
  189.     } STORE_ATTR_TYPES;
  190. /* Attribute value sizes.  -1 means unknown, anything else is the required size. */
  191. extern const int STORE_attr_sizes[STORE_ATTR_TYPE_NUM+1];
  192.  
  193. typedef enum STORE_certificate_status
  194.     {
  195.     STORE_X509_VALID=            0x00,
  196.     STORE_X509_EXPIRED=            0x01,
  197.     STORE_X509_SUSPENDED=            0x02,
  198.     STORE_X509_REVOKED=            0x03
  199.     } STORE_CERTIFICATE_STATUS;
  200.  
  201. /* Engine store functions will return a structure that contains all the necessary
  202.  * information, including revokation status for certificates.  This is really not
  203.  * needed for application authors, as the ENGINE framework functions will extract
  204.  * the OpenSSL-specific information when at all possible.  However, for engine
  205.  * authors, it's crucial to know this structure.  */
  206. typedef struct STORE_OBJECT_st
  207.     {
  208.     STORE_OBJECT_TYPES type;
  209.     union
  210.         {
  211.         struct
  212.             {
  213.             STORE_CERTIFICATE_STATUS status;
  214.             X509 *certificate;
  215.             } x509;
  216.         X509_CRL *crl;
  217.         EVP_PKEY *key;
  218.         BIGNUM *number;
  219.         BUF_MEM *arbitrary;
  220.         } data;
  221.     } STORE_OBJECT;
  222. DECLARE_STACK_OF(STORE_OBJECT)
  223. STORE_OBJECT *STORE_OBJECT_new(void);
  224. void STORE_OBJECT_free(STORE_OBJECT *data);
  225.  
  226.  
  227.  
  228. /* The following functions handle the storage. They return 0, a negative number
  229.    or NULL on error, anything else on success. */
  230. X509 *STORE_get_certificate(STORE *e, OPENSSL_ITEM attributes[],
  231.     OPENSSL_ITEM parameters[]);
  232. int STORE_store_certificate(STORE *e, X509 *data, OPENSSL_ITEM attributes[],
  233.     OPENSSL_ITEM parameters[]);
  234. int STORE_modify_certificate(STORE *e, OPENSSL_ITEM search_attributes[],
  235.     OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[],
  236.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  237. int STORE_revoke_certificate(STORE *e, OPENSSL_ITEM attributes[],
  238.     OPENSSL_ITEM parameters[]);
  239. int STORE_delete_certificate(STORE *e, OPENSSL_ITEM attributes[],
  240.     OPENSSL_ITEM parameters[]);
  241. void *STORE_list_certificate_start(STORE *e, OPENSSL_ITEM attributes[],
  242.     OPENSSL_ITEM parameters[]);
  243. X509 *STORE_list_certificate_next(STORE *e, void *handle);
  244. int STORE_list_certificate_end(STORE *e, void *handle);
  245. int STORE_list_certificate_endp(STORE *e, void *handle);
  246. EVP_PKEY *STORE_generate_key(STORE *e, OPENSSL_ITEM attributes[],
  247.     OPENSSL_ITEM parameters[]);
  248. EVP_PKEY *STORE_get_private_key(STORE *e, OPENSSL_ITEM attributes[],
  249.     OPENSSL_ITEM parameters[]);
  250. int STORE_store_private_key(STORE *e, EVP_PKEY *data,
  251.     OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  252. int STORE_modify_private_key(STORE *e, OPENSSL_ITEM search_attributes[],
  253.     OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
  254.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  255. int STORE_revoke_private_key(STORE *e, OPENSSL_ITEM attributes[],
  256.     OPENSSL_ITEM parameters[]);
  257. int STORE_delete_private_key(STORE *e, OPENSSL_ITEM attributes[],
  258.     OPENSSL_ITEM parameters[]);
  259. void *STORE_list_private_key_start(STORE *e, OPENSSL_ITEM attributes[],
  260.     OPENSSL_ITEM parameters[]);
  261. EVP_PKEY *STORE_list_private_key_next(STORE *e, void *handle);
  262. int STORE_list_private_key_end(STORE *e, void *handle);
  263. int STORE_list_private_key_endp(STORE *e, void *handle);
  264. EVP_PKEY *STORE_get_public_key(STORE *e, OPENSSL_ITEM attributes[],
  265.     OPENSSL_ITEM parameters[]);
  266. int STORE_store_public_key(STORE *e, EVP_PKEY *data, OPENSSL_ITEM attributes[],
  267.     OPENSSL_ITEM parameters[]);
  268. int STORE_modify_public_key(STORE *e, OPENSSL_ITEM search_attributes[],
  269.     OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
  270.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  271. int STORE_revoke_public_key(STORE *e, OPENSSL_ITEM attributes[],
  272.     OPENSSL_ITEM parameters[]);
  273. int STORE_delete_public_key(STORE *e, OPENSSL_ITEM attributes[],
  274.     OPENSSL_ITEM parameters[]);
  275. void *STORE_list_public_key_start(STORE *e, OPENSSL_ITEM attributes[],
  276.     OPENSSL_ITEM parameters[]);
  277. EVP_PKEY *STORE_list_public_key_next(STORE *e, void *handle);
  278. int STORE_list_public_key_end(STORE *e, void *handle);
  279. int STORE_list_public_key_endp(STORE *e, void *handle);
  280. X509_CRL *STORE_generate_crl(STORE *e, OPENSSL_ITEM attributes[],
  281.     OPENSSL_ITEM parameters[]);
  282. X509_CRL *STORE_get_crl(STORE *e, OPENSSL_ITEM attributes[],
  283.     OPENSSL_ITEM parameters[]);
  284. int STORE_store_crl(STORE *e, X509_CRL *data, OPENSSL_ITEM attributes[],
  285.     OPENSSL_ITEM parameters[]);
  286. int STORE_modify_crl(STORE *e, OPENSSL_ITEM search_attributes[],
  287.     OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
  288.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  289. int STORE_delete_crl(STORE *e, OPENSSL_ITEM attributes[],
  290.     OPENSSL_ITEM parameters[]);
  291. void *STORE_list_crl_start(STORE *e, OPENSSL_ITEM attributes[],
  292.     OPENSSL_ITEM parameters[]);
  293. X509_CRL *STORE_list_crl_next(STORE *e, void *handle);
  294. int STORE_list_crl_end(STORE *e, void *handle);
  295. int STORE_list_crl_endp(STORE *e, void *handle);
  296. int STORE_store_number(STORE *e, BIGNUM *data, OPENSSL_ITEM attributes[],
  297.     OPENSSL_ITEM parameters[]);
  298. int STORE_modify_number(STORE *e, OPENSSL_ITEM search_attributes[],
  299.     OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
  300.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  301. BIGNUM *STORE_get_number(STORE *e, OPENSSL_ITEM attributes[],
  302.     OPENSSL_ITEM parameters[]);
  303. int STORE_delete_number(STORE *e, OPENSSL_ITEM attributes[],
  304.     OPENSSL_ITEM parameters[]);
  305. int STORE_store_arbitrary(STORE *e, BUF_MEM *data, OPENSSL_ITEM attributes[],
  306.     OPENSSL_ITEM parameters[]);
  307. int STORE_modify_arbitrary(STORE *e, OPENSSL_ITEM search_attributes[],
  308.     OPENSSL_ITEM add_sttributes[], OPENSSL_ITEM modify_attributes[],
  309.     OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  310. BUF_MEM *STORE_get_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
  311.     OPENSSL_ITEM parameters[]);
  312. int STORE_delete_arbitrary(STORE *e, OPENSSL_ITEM attributes[],
  313.     OPENSSL_ITEM parameters[]);
  314.  
  315.  
  316. /* Create and manipulate methods */
  317. STORE_METHOD *STORE_create_method(char *name);
  318. void STORE_destroy_method(STORE_METHOD *store_method);
  319.  
  320. /* These callback types are use for store handlers */
  321. typedef int (*STORE_INITIALISE_FUNC_PTR)(STORE *);
  322. typedef void (*STORE_CLEANUP_FUNC_PTR)(STORE *);
  323. typedef STORE_OBJECT *(*STORE_GENERATE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  324. typedef STORE_OBJECT *(*STORE_GET_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  325. typedef void *(*STORE_START_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  326. typedef STORE_OBJECT *(*STORE_NEXT_OBJECT_FUNC_PTR)(STORE *, void *handle);
  327. typedef int (*STORE_END_OBJECT_FUNC_PTR)(STORE *, void *handle);
  328. typedef int (*STORE_HANDLE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  329. typedef int (*STORE_STORE_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, STORE_OBJECT *data, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  330. typedef int (*STORE_MODIFY_OBJECT_FUNC_PTR)(STORE *, STORE_OBJECT_TYPES type, OPENSSL_ITEM search_attributes[], OPENSSL_ITEM add_attributes[], OPENSSL_ITEM modify_attributes[], OPENSSL_ITEM delete_attributes[], OPENSSL_ITEM parameters[]);
  331. typedef int (*STORE_GENERIC_FUNC_PTR)(STORE *, OPENSSL_ITEM attributes[], OPENSSL_ITEM parameters[]);
  332. typedef int (*STORE_CTRL_FUNC_PTR)(STORE *, int cmd, long l, void *p, void (*f)(void));
  333.  
  334. int STORE_method_set_initialise_function(STORE_METHOD *sm, STORE_INITIALISE_FUNC_PTR init_f);
  335. int STORE_method_set_cleanup_function(STORE_METHOD *sm, STORE_CLEANUP_FUNC_PTR clean_f);
  336. int STORE_method_set_generate_function(STORE_METHOD *sm, STORE_GENERATE_OBJECT_FUNC_PTR generate_f);
  337. int STORE_method_set_get_function(STORE_METHOD *sm, STORE_GET_OBJECT_FUNC_PTR get_f);
  338. int STORE_method_set_store_function(STORE_METHOD *sm, STORE_STORE_OBJECT_FUNC_PTR store_f);
  339. int STORE_method_set_modify_function(STORE_METHOD *sm, STORE_MODIFY_OBJECT_FUNC_PTR store_f);
  340. int STORE_method_set_revoke_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR revoke_f);
  341. int STORE_method_set_delete_function(STORE_METHOD *sm, STORE_HANDLE_OBJECT_FUNC_PTR delete_f);
  342. int STORE_method_set_list_start_function(STORE_METHOD *sm, STORE_START_OBJECT_FUNC_PTR list_start_f);
  343. int STORE_method_set_list_next_function(STORE_METHOD *sm, STORE_NEXT_OBJECT_FUNC_PTR list_next_f);
  344. int STORE_method_set_list_end_function(STORE_METHOD *sm, STORE_END_OBJECT_FUNC_PTR list_end_f);
  345. int STORE_method_set_update_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
  346. int STORE_method_set_lock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
  347. int STORE_method_set_unlock_store_function(STORE_METHOD *sm, STORE_GENERIC_FUNC_PTR);
  348. int STORE_method_set_ctrl_function(STORE_METHOD *sm, STORE_CTRL_FUNC_PTR ctrl_f);
  349.  
  350. STORE_INITIALISE_FUNC_PTR STORE_method_get_initialise_function(STORE_METHOD *sm);
  351. STORE_CLEANUP_FUNC_PTR STORE_method_get_cleanup_function(STORE_METHOD *sm);
  352. STORE_GENERATE_OBJECT_FUNC_PTR STORE_method_get_generate_function(STORE_METHOD *sm);
  353. STORE_GET_OBJECT_FUNC_PTR STORE_method_get_get_function(STORE_METHOD *sm);
  354. STORE_STORE_OBJECT_FUNC_PTR STORE_method_get_store_function(STORE_METHOD *sm);
  355. STORE_MODIFY_OBJECT_FUNC_PTR STORE_method_get_modify_function(STORE_METHOD *sm);
  356. STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_revoke_function(STORE_METHOD *sm);
  357. STORE_HANDLE_OBJECT_FUNC_PTR STORE_method_get_delete_function(STORE_METHOD *sm);
  358. STORE_START_OBJECT_FUNC_PTR STORE_method_get_list_start_function(STORE_METHOD *sm);
  359. STORE_NEXT_OBJECT_FUNC_PTR STORE_method_get_list_next_function(STORE_METHOD *sm);
  360. STORE_END_OBJECT_FUNC_PTR STORE_method_get_list_end_function(STORE_METHOD *sm);
  361. STORE_GENERIC_FUNC_PTR STORE_method_get_update_store_function(STORE_METHOD *sm);
  362. STORE_GENERIC_FUNC_PTR STORE_method_get_lock_store_function(STORE_METHOD *sm);
  363. STORE_GENERIC_FUNC_PTR STORE_method_get_unlock_store_function(STORE_METHOD *sm);
  364. STORE_CTRL_FUNC_PTR STORE_method_get_ctrl_function(STORE_METHOD *sm);
  365.  
  366. /* Method helper structures and functions. */
  367.  
  368. /* This structure is the result of parsing through the information in a list
  369.    of OPENSSL_ITEMs.  It stores all the necessary information in a structured
  370.    way.*/
  371. typedef struct STORE_attr_info_st STORE_ATTR_INFO;
  372.  
  373. /* Parse a list of OPENSSL_ITEMs and return a pointer to a STORE_ATTR_INFO.
  374.    Note that we do this in the list form, since the list of OPENSSL_ITEMs can
  375.    come in blocks separated with STORE_ATTR_OR.  Note that the value returned
  376.    by STORE_parse_attrs_next() must be freed with STORE_ATTR_INFO_free(). */
  377. void *STORE_parse_attrs_start(OPENSSL_ITEM *attributes);
  378. STORE_ATTR_INFO *STORE_parse_attrs_next(void *handle);
  379. int STORE_parse_attrs_end(void *handle);
  380. int STORE_parse_attrs_endp(void *handle);
  381.  
  382. /* Creator and destructor */
  383. STORE_ATTR_INFO *STORE_ATTR_INFO_new(void);
  384. int STORE_ATTR_INFO_free(STORE_ATTR_INFO *attrs);
  385.  
  386. /* Manipulators */
  387. char *STORE_ATTR_INFO_get0_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
  388. unsigned char *STORE_ATTR_INFO_get0_sha1str(STORE_ATTR_INFO *attrs,
  389.     STORE_ATTR_TYPES code);
  390. X509_NAME *STORE_ATTR_INFO_get0_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
  391. BIGNUM *STORE_ATTR_INFO_get0_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code);
  392. int STORE_ATTR_INFO_set_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  393.     char *cstr, size_t cstr_size);
  394. int STORE_ATTR_INFO_set_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  395.     unsigned char *sha1str, size_t sha1str_size);
  396. int STORE_ATTR_INFO_set_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  397.     X509_NAME *dn);
  398. int STORE_ATTR_INFO_set_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  399.     BIGNUM *number);
  400. int STORE_ATTR_INFO_modify_cstr(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  401.     char *cstr, size_t cstr_size);
  402. int STORE_ATTR_INFO_modify_sha1str(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  403.     unsigned char *sha1str, size_t sha1str_size);
  404. int STORE_ATTR_INFO_modify_dn(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  405.     X509_NAME *dn);
  406. int STORE_ATTR_INFO_modify_number(STORE_ATTR_INFO *attrs, STORE_ATTR_TYPES code,
  407.     BIGNUM *number);
  408.  
  409. /* Compare on basis of a bit pattern formed by the STORE_ATTR_TYPES values
  410.    in each contained attribute. */
  411. int STORE_ATTR_INFO_compare(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
  412. /* Check if the set of attributes in a is within the range of attributes
  413.    set in b. */
  414. int STORE_ATTR_INFO_in_range(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
  415. /* Check if the set of attributes in a are also set in b. */
  416. int STORE_ATTR_INFO_in(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
  417. /* Same as STORE_ATTR_INFO_in(), but also checks the attribute values. */
  418. int STORE_ATTR_INFO_in_ex(STORE_ATTR_INFO *a, STORE_ATTR_INFO *b);
  419.  
  420.  
  421. /* BEGIN ERROR CODES */
  422. /* The following lines are auto generated by the script mkerr.pl. Any changes
  423.  * made after this point may be overwritten when the script is next run.
  424.  */
  425. void ERR_load_STORE_strings(void);
  426.  
  427. /* Error codes for the STORE functions. */
  428.  
  429. /* Function codes. */
  430. #define STORE_F_MEM_DELETE                 134
  431. #define STORE_F_MEM_GENERATE                 135
  432. #define STORE_F_MEM_LIST_END                 168
  433. #define STORE_F_MEM_LIST_NEXT                 136
  434. #define STORE_F_MEM_LIST_START                 137
  435. #define STORE_F_MEM_MODIFY                 169
  436. #define STORE_F_MEM_STORE                 138
  437. #define STORE_F_STORE_ATTR_INFO_GET0_CSTR         139
  438. #define STORE_F_STORE_ATTR_INFO_GET0_DN             140
  439. #define STORE_F_STORE_ATTR_INFO_GET0_NUMBER         141
  440. #define STORE_F_STORE_ATTR_INFO_GET0_SHA1STR         142
  441. #define STORE_F_STORE_ATTR_INFO_MODIFY_CSTR         143
  442. #define STORE_F_STORE_ATTR_INFO_MODIFY_DN         144
  443. #define STORE_F_STORE_ATTR_INFO_MODIFY_NUMBER         145
  444. #define STORE_F_STORE_ATTR_INFO_MODIFY_SHA1STR         146
  445. #define STORE_F_STORE_ATTR_INFO_SET_CSTR         147
  446. #define STORE_F_STORE_ATTR_INFO_SET_DN             148
  447. #define STORE_F_STORE_ATTR_INFO_SET_NUMBER         149
  448. #define STORE_F_STORE_ATTR_INFO_SET_SHA1STR         150
  449. #define STORE_F_STORE_CERTIFICATE             170
  450. #define STORE_F_STORE_CTRL                 161
  451. #define STORE_F_STORE_DELETE_ARBITRARY             158
  452. #define STORE_F_STORE_DELETE_CERTIFICATE         102
  453. #define STORE_F_STORE_DELETE_CRL             103
  454. #define STORE_F_STORE_DELETE_NUMBER             104
  455. #define STORE_F_STORE_DELETE_PRIVATE_KEY         105
  456. #define STORE_F_STORE_DELETE_PUBLIC_KEY             106
  457. #define STORE_F_STORE_GENERATE_CRL             107
  458. #define STORE_F_STORE_GENERATE_KEY             108
  459. #define STORE_F_STORE_GET_ARBITRARY             159
  460. #define STORE_F_STORE_GET_CERTIFICATE             109
  461. #define STORE_F_STORE_GET_CRL                 110
  462. #define STORE_F_STORE_GET_NUMBER             111
  463. #define STORE_F_STORE_GET_PRIVATE_KEY             112
  464. #define STORE_F_STORE_GET_PUBLIC_KEY             113
  465. #define STORE_F_STORE_LIST_CERTIFICATE_END         114
  466. #define STORE_F_STORE_LIST_CERTIFICATE_ENDP         153
  467. #define STORE_F_STORE_LIST_CERTIFICATE_NEXT         115
  468. #define STORE_F_STORE_LIST_CERTIFICATE_START         116
  469. #define STORE_F_STORE_LIST_CRL_END             117
  470. #define STORE_F_STORE_LIST_CRL_ENDP             154
  471. #define STORE_F_STORE_LIST_CRL_NEXT             118
  472. #define STORE_F_STORE_LIST_CRL_START             119
  473. #define STORE_F_STORE_LIST_PRIVATE_KEY_END         120
  474. #define STORE_F_STORE_LIST_PRIVATE_KEY_ENDP         155
  475. #define STORE_F_STORE_LIST_PRIVATE_KEY_NEXT         121
  476. #define STORE_F_STORE_LIST_PRIVATE_KEY_START         122
  477. #define STORE_F_STORE_LIST_PUBLIC_KEY_END         123
  478. #define STORE_F_STORE_LIST_PUBLIC_KEY_ENDP         156
  479. #define STORE_F_STORE_LIST_PUBLIC_KEY_NEXT         124
  480. #define STORE_F_STORE_LIST_PUBLIC_KEY_START         125
  481. #define STORE_F_STORE_MODIFY_ARBITRARY             162
  482. #define STORE_F_STORE_MODIFY_CERTIFICATE         163
  483. #define STORE_F_STORE_MODIFY_CRL             164
  484. #define STORE_F_STORE_MODIFY_NUMBER             165
  485. #define STORE_F_STORE_MODIFY_PRIVATE_KEY         166
  486. #define STORE_F_STORE_MODIFY_PUBLIC_KEY             167
  487. #define STORE_F_STORE_NEW_ENGINE             133
  488. #define STORE_F_STORE_NEW_METHOD             132
  489. #define STORE_F_STORE_PARSE_ATTRS_END             151
  490. #define STORE_F_STORE_PARSE_ATTRS_ENDP             172
  491. #define STORE_F_STORE_PARSE_ATTRS_NEXT             152
  492. #define STORE_F_STORE_PARSE_ATTRS_START             171
  493. #define STORE_F_STORE_REVOKE_CERTIFICATE         129
  494. #define STORE_F_STORE_REVOKE_PRIVATE_KEY         130
  495. #define STORE_F_STORE_REVOKE_PUBLIC_KEY             131
  496. #define STORE_F_STORE_STORE_ARBITRARY             157
  497. #define STORE_F_STORE_STORE_CERTIFICATE             100
  498. #define STORE_F_STORE_STORE_CRL                 101
  499. #define STORE_F_STORE_STORE_NUMBER             126
  500. #define STORE_F_STORE_STORE_PRIVATE_KEY             127
  501. #define STORE_F_STORE_STORE_PUBLIC_KEY             128
  502.  
  503. /* Reason codes. */
  504. #define STORE_R_ALREADY_HAS_A_VALUE             127
  505. #define STORE_R_FAILED_DELETING_ARBITRARY         132
  506. #define STORE_R_FAILED_DELETING_CERTIFICATE         100
  507. #define STORE_R_FAILED_DELETING_KEY             101
  508. #define STORE_R_FAILED_DELETING_NUMBER             102
  509. #define STORE_R_FAILED_GENERATING_CRL             103
  510. #define STORE_R_FAILED_GENERATING_KEY             104
  511. #define STORE_R_FAILED_GETTING_ARBITRARY         133
  512. #define STORE_R_FAILED_GETTING_CERTIFICATE         105
  513. #define STORE_R_FAILED_GETTING_KEY             106
  514. #define STORE_R_FAILED_GETTING_NUMBER             107
  515. #define STORE_R_FAILED_LISTING_CERTIFICATES         108
  516. #define STORE_R_FAILED_LISTING_KEYS             109
  517. #define STORE_R_FAILED_MODIFYING_ARBITRARY         138
  518. #define STORE_R_FAILED_MODIFYING_CERTIFICATE         139
  519. #define STORE_R_FAILED_MODIFYING_CRL             140
  520. #define STORE_R_FAILED_MODIFYING_NUMBER             141
  521. #define STORE_R_FAILED_MODIFYING_PRIVATE_KEY         142
  522. #define STORE_R_FAILED_MODIFYING_PUBLIC_KEY         143
  523. #define STORE_R_FAILED_REVOKING_CERTIFICATE         110
  524. #define STORE_R_FAILED_REVOKING_KEY             111
  525. #define STORE_R_FAILED_STORING_ARBITRARY         134
  526. #define STORE_R_FAILED_STORING_CERTIFICATE         112
  527. #define STORE_R_FAILED_STORING_KEY             113
  528. #define STORE_R_FAILED_STORING_NUMBER             114
  529. #define STORE_R_NOT_IMPLEMENTED                 128
  530. #define STORE_R_NO_CONTROL_FUNCTION             144
  531. #define STORE_R_NO_DELETE_ARBITRARY_FUNCTION         135
  532. #define STORE_R_NO_DELETE_NUMBER_FUNCTION         115
  533. #define STORE_R_NO_DELETE_OBJECT_FUNCTION         116
  534. #define STORE_R_NO_GENERATE_CRL_FUNCTION         117
  535. #define STORE_R_NO_GENERATE_OBJECT_FUNCTION         118
  536. #define STORE_R_NO_GET_OBJECT_ARBITRARY_FUNCTION     136
  537. #define STORE_R_NO_GET_OBJECT_FUNCTION             119
  538. #define STORE_R_NO_GET_OBJECT_NUMBER_FUNCTION         120
  539. #define STORE_R_NO_LIST_OBJECT_ENDP_FUNCTION         131
  540. #define STORE_R_NO_LIST_OBJECT_END_FUNCTION         121
  541. #define STORE_R_NO_LIST_OBJECT_NEXT_FUNCTION         122
  542. #define STORE_R_NO_LIST_OBJECT_START_FUNCTION         123
  543. #define STORE_R_NO_MODIFY_OBJECT_FUNCTION         145
  544. #define STORE_R_NO_REVOKE_OBJECT_FUNCTION         124
  545. #define STORE_R_NO_STORE                 129
  546. #define STORE_R_NO_STORE_OBJECT_ARBITRARY_FUNCTION     137
  547. #define STORE_R_NO_STORE_OBJECT_FUNCTION         125
  548. #define STORE_R_NO_STORE_OBJECT_NUMBER_FUNCTION         126
  549. #define STORE_R_NO_VALUE                 130
  550.  
  551. #ifdef  __cplusplus
  552. }
  553. #endif
  554. #endif
  555.